<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>WikiPlot Syntax Reference</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
	<table class="tutorial-nav-box">
	<tr>
		<td style="width: 30%">
							<a href="../WikiPlot/tutorial_WikiPlot.pkg.html" class="nav-button">Previous</a>
					</td>
		<td style="text-align: center">
					</td>
		<td style="text-align: right; width: 30%">
							<span class="nav-button-disabled">Next</span>
					</td>
	</tr>
	<tr>
		<td style="width: 30%">
							<span class="detail">WikiPlot Userguide</span>
					</td>
		<td style="text-align: center">
					</td>
		<td style="text-align: right; width: 30%">
					</td>
	</tr>
</table>
	
<div><a name=""></a><div class="ref-title-box">WikiPlot Syntax Reference<h1 class="ref-title">WikiPlot Syntax Reference</h1>
		<h2 class="ref-purpose">Complete WikiPlot syntax reference</h2></div>
	<div class="ref-synopsis"><p>The WikiPlot Development Team.</p>
		<div class="authors"><h2 class="title">Authors</h2><span class="author">Jonas F. Jensen.
				<div class="author-blurb"><a href="mailto:wikiplot@jopsen.dk">WikiPlot@Jopsen.dk</a></div></span>
			<span class="author">Ismail Faizi
				<div class="author-blurb"><a href="mailto:kanafghan@gmail.com">KanAfghan@Gmail.com</a></div></span></div></div>
	<span><a name="Reference"></a><h2 class="title">WikiPlot Syntax Reference</h2><p>This is a complete syntax reference for WikiPlot, if you are note familiar with xml or the most common MediaWiki syntax, it is recommended that you read the WikiPlot UserGuide first. Below you will find a documentation of the parameters and content for the wikiplot and graph tag,  respectively. At the end of the article you will find a complete example of a plot with use of all parameters.</p>
		<span><h3 class="title">wikiplot parameters and content</h3><p>The wikiplot tag contains one or more graph tags, the graph tags defines the different mathematical expressions to be plotted. The wikiplot tag defines the image/environment/coordinate-system these mathematical expressions are to be plotted upon. The wikiplot tag takes following parameters:</p>
			<ul mark = "bullet"><li><p><em>caption</em></p>
					<blockquote><p>Defines the caption of the plot, is shown i the top centered on the final image. Leave empty or do not define this parameter, you do not want any caption on your image.</p></blockquote></li>
				<li><p><em>captionfont</em></p>
					<blockquote><p>An integer representing font type of the caption, fonts 1-5 are built-in and represents different font sizes 1 being smallest and 5 biggest, defaults to 5.</p></blockquote></li>
				<li><p><em>height</em></p>
					<blockquote><p>An integer, defining the the height of the final image in pixels.</p></blockquote></li>
				<li><p><em>width</em></p>
					<blockquote><p>An integer, defining the width of the final image in pixels.</p></blockquote></li>
				<li><p><em>xspan</em></p>
					<blockquote><p>Two semicolon separated integers, defining the span of the x-axis. If xspan=&quot;-5;10&quot; the minimum value on the x-axis will be -5 and the maximum value on the x-axis will be 10. This parameter is very important, because it defines coordinate space to be viewed.</p></blockquote></li>
				<li><p><em>yspan</em></p>
					<blockquote><p>Two semicolon separated integers, defining the span of the y-axis. If yspan=&quot;-5;10&quot; the minimum value on the y-axis will be -5 and the maximum value on the y-axis will be 10. This parameter is very important, because it defines coordinate space to be viewed.</p></blockquote></li>
				<li><p><em>axis</em></p>
					<blockquote><p>Enable or disable axis, whether or not to show axis x=0 and y=0. Defaults to true, valid values are: &quot;true&quot; or &quot;false&quot;.</p></blockquote></li>
				<li><p><em>grid</em></p>
					<blockquote><p>Enable or disable grid, whether or not to show grid, that makes it easier to read the plot. Defaults to true, valid values are: &quot;true&quot; or &quot;false&quot;.</p></blockquote></li>
				<li><p><em>gridspace</em></p>
					<blockquote><p>Two semicolon separated integers, defining the space between the line of the grid. If this is not defined, WikiPlot will calculate some appropriate values, but these might not always look good. If gridspace=&quot;10;20&quot; the distance between the grid-lines on the x-axis will be 10 and the distance between the grid-lines on the x-axis will be 20.</p></blockquote></li>
				<li><p><em>gridfont</em></p>
					<blockquote><p>An integer representing font type of the labels at the grid, fonts 1-5 are built-in and represents different font sizes 1 being smallest and 5 biggest, defaults to 1.</p></blockquote></li>
				<li><p><em>gridcolor</em></p>
					<blockquote><p>Three semicolon separated integers, defining the color of the grid-lines, defaults to gray. This gridcolor=&quot;240,240,240&quot; is an RGB (Red,Green,Blue) representation of variant of the color gray.</p></blockquote></li></ul></span>
		<span><h3 class="title">graph parameters and content</h3><p>The graph tags represents different mathematical expressions, that are to be plotted onto the coordinate-system defined by the surrounding/parent wikiplot tag. The graph tag contains the mathematical expression, it is representing. This mathematical expression may contain the variable x, and following mathematical functions:</p>
			<ul><li>sin()</li>
				<li>sinh()</li>
				<li>arcsin()</li>
				<li>asin()</li>
				<li>arcsinh()</li>
				<li>asinh()</li>
				<li>cos()</li>
				<li>cosh()</li>
				<li>arccos()</li>
				<li>acos()</li>
				<li>arccosh()</li>
				<li>acosh()</li>
				<li>tan()</li>
				<li>tanh()</li>
				<li>arctan()</li>
				<li>atan()</li>
				<li>arctanh()</li>
				<li>atanh()</li>
				<li>sqrt()</li>
				<li>abs()</li>
				<li>ln()</li>
				<li>log()</li></ul>
			<p>Apart from these mathematical functions you may also use following constants:</p>
			<ul><li>e</li>
				<li>pi</li></ul>
			<p>And last but not least, you may also use following mathematical operators:</p>
			<ul><li>+</li>
				<li>-</li>
				<li>*</li>
				<li>/</li>
				<li>^</li></ul>
			<p>If you have any questions regarding these mathematical expressions feel free to contact us, or take a look at the source found in evalmath.class.php. We have not documented this class because we have not written it. The graph tag also takes certain parameters that allow you to affect the way it is represented on the plot. The graph tag takes following parameters:</p>
			<ul mark = "bullet"><li><p><em>label</em></p>
					<blockquote><p>A label shown in the top left corner to identify the graph, this label will be printed in same color as the mathematical expression will be plotted. Leave empty or do not define this parameter, if you do not want any label for your mathematical expression.</p></blockquote></li>
				<li><p><em>color</em></p>
					<blockquote><p>Three semicolon separated integers, defining the color of the label and plotted mathematical expression, defaults to black. This color=&quot;0,0,0&quot; is an RGB (Red,Green,Blue) representation of the color black.</p></blockquote></li></ul></span>
		<span><h3 class="title">Complete Example</h3><p>Following is an advanced example of how WikiPlot could be used. Normally you don't need to used all parameters, most basic ones are covered in depth in the WikiPlot Userguide. This is a pretty extreme example of how to use all parameters:</p>
		<div class="src-code"><pre>
&lt;wikiplot height=&quot;400&quot; width=&quot;800&quot; caption=&quot;Complete Example&quot;
	 xspan=&quot;-100;100&quot; yspan=&quot;-200;200&quot; gridspace=&quot;10;20&quot; 
	captionfont=&quot;4&quot; gridfont=&quot;2&quot; axis=&quot;true&quot; grid=&quot;true&quot;&gt;
	&lt;graph label=&quot;A red graph&quot; color=&quot;255,0,0&quot;&gt;x^2+4&lt;/graph&gt;
	&lt;graph label=&quot;A blue graph&quot; color=&quot;0,0,255&quot;&gt;3*x-3&lt;/graph&gt;
&lt;/wikiplot&gt;
</pre></div></span></span></div>

	<table class="tutorial-nav-box">
	<tr>
		<td style="width: 30%">
							<a href="../WikiPlot/tutorial_WikiPlot.pkg.html" class="nav-button">Previous</a>
					</td>
		<td style="text-align: center">
					</td>
		<td style="text-align: right; width: 30%">
							<span class="nav-button-disabled">Next</span>
					</td>
	</tr>
	<tr>
		<td style="width: 30%">
							<span class="detail">WikiPlot Userguide</span>
					</td>
		<td style="text-align: center">
					</td>
		<td style="text-align: right; width: 30%">
					</td>
	</tr>
</table>
	
	<p class="notes" id="credit">
		Documentation generated on Fri, 13 Oct 2006 16:12:22 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0</a>
	</p>
	</div></body>
</html>